<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>RoleType xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/gwt/charts/client/RoleType.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright 2012 Rui Afonso</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * specific language governing permissions and limitations under the License.</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <strong class="jxr_keyword">package</strong> com.googlecode.gwt.charts.client;
<a class="jxr_linenumber" name="14" href="#14">14</a>  
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * A column role describes the purpose of the data in that column: for example, a column might hold data describing</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * tooltip text, data point annotations, or uncertainty indicators.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="http://developers.google.com/chart/interactive/docs/roles.html" target="alexandria_uri">http://developers.google.com/chart/interactive/docs/roles.html</a>"&gt;DataTable Roles&lt;/a&gt;</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">public</strong> enum <a href="../../../../../com/googlecode/gwt/charts/client/RoleType.html">RoleType</a> {
<a class="jxr_linenumber" name="21" href="#21">21</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_javadoccomment">	 * You should not need to assign this role explicitly unless designing a multi-domain chart (shown here); the basic</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_javadoccomment">	 * format of the data table enables the charting engine to infer which columns are domain columns. However, you</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment">	 * should be aware of which columns are domain columns so that you know which other columns can modify it. Domain</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment">	 * columns specify labels along the major axis of the chart. Multiple domain columns can sometimes be used to</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment">	 * support multiple scales within the same chart. Data type: Usually string, but occasionally number or date</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  	DOMAIN(<span class="jxr_string">"domain"</span>),
<a class="jxr_linenumber" name="29" href="#29">29</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">	 You should not need to assign this role explicitly; the basic format of the data table enables the charting</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment">	 * engine to infer which columns are domain columns. However, you sould be aware of which columns are data columns</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment">	 * so that you know which other columns can modify it. Data role columns specify series data to render in the chart.</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment">	 * For most charts, one column = one series, but this can vary by chart type (for example, scatter charts require</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment">	 * two data columns for the first series, and an additional one for each additional series; candlestick charts</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment">	 * require four data columns for each series). Data type: number</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  	DATA(<span class="jxr_string">"data"</span>),
<a class="jxr_linenumber" name="39" href="#39">39</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">	 * Text to display on the chart near the associated data point. The text displays without any user interaction.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">	 * Annotations and annotation text can be assigned to both data points and categories (axis labels). There are two</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">	 * styles of annotations: letter (default), which draws the annotation text near the specified point, and line,</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">	 * which draws the annotation text on a line that bisects the chart area. Line annotations only apply to domain</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * values, not data values. You can specify the line style by setting this chart option: annotation: {'column_id':</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 * {style: 'line'}} Data type: string Default: Empty string</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  	ANNOTATION(<span class="jxr_string">"annotation"</span>),
<a class="jxr_linenumber" name="48" href="#48">48</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 * Extended text to display when the user hovers over the associated annotation. Annotations and annotation text can</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">	 * be assigned to both data points and categories (axis labels). If you have an annotationText column, you must also</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">	 * have an annotation column. Tooltip text, in contrast, is displayed when the user hovers over the associated data</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">	 * point on the chart. Data type: string Default: Empty string</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  	ANNOTATIONTEXT(<span class="jxr_string">"annotationText"</span>),
<a class="jxr_linenumber" name="55" href="#55">55</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">	 * Indicates potential data range for a specific point. Intervals are usually displayed as I-bar style range</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">	 * indicators. Interval columns are numeric columns; add interval columns in pairs, marking the low and high value</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">	 * of the bar. Interval values should be added in increasing value, from left to right. Data type: number Default:</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">	 * No interval</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  	INTERVAL(<span class="jxr_string">"interval"</span>),
<a class="jxr_linenumber" name="62" href="#62">62</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">	 * Text to display when the user hovers over the data point associated with this row. Data type: string Default:</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">	 * Data point value</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  	TOOLTIP(<span class="jxr_string">"tooltip"</span>),
<a class="jxr_linenumber" name="67" href="#67">67</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment">	 Indicates whether a data point is certain or not. How this is displayed depends on the chart type—for example, it</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">	 * might be indicated by dashed lines or a striped fill. For line and area charts, the segment between two data</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">	 * points is certain if and only if both data points are certain. Data type: boolean, where true is certain, false</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">	 * is uncertain. Default: true</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  	CERTAINTY(<span class="jxr_string">"certainty"</span>),
<a class="jxr_linenumber" name="75" href="#75">75</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">	 * Emphasizes specified chart data points. Displayed as a thick line and/or large point. For line and area charts,</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">	 * the segment between two data points is emphasized if and only if both data points are emphasized. Data type:</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">	 * boolean Default: false</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>  	EMPHASIS(<span class="jxr_string">"emphasis"</span>),
<a class="jxr_linenumber" name="81" href="#81">81</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 * Indicates whether a point is in or out of scope. If a point is out of scope, it is visually de-emphasized. For</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">	 * line and area charts, the segment between two data points is in scope if either endpoint is in scope. Data type:</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">	 * boolean, where true means in scope. Default: true</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  	SCOPE(<span class="jxr_string">"scope"</span>);
<a class="jxr_linenumber" name="87" href="#87">87</a>  
<a class="jxr_linenumber" name="88" href="#88">88</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">	 * Get a RoleType by providing its name.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">	 * @param name the RoleType name.</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">	 * @return a RoleType corresponding to the provided name.</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../com/googlecode/gwt/charts/client/RoleType.html">RoleType</a> findByName(String name) {
<a class="jxr_linenumber" name="95" href="#95">95</a>  		<strong class="jxr_keyword">for</strong> (RoleType roleType : RoleType.values()) {
<a class="jxr_linenumber" name="96" href="#96">96</a>  			<strong class="jxr_keyword">if</strong> (roleType.getName().equals(name)) {
<a class="jxr_linenumber" name="97" href="#97">97</a>  				<strong class="jxr_keyword">return</strong> roleType;
<a class="jxr_linenumber" name="98" href="#98">98</a>  			}
<a class="jxr_linenumber" name="99" href="#99">99</a>  		}
<a class="jxr_linenumber" name="100" href="#100">100</a> 		<strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="101" href="#101">101</a> 	}
<a class="jxr_linenumber" name="102" href="#102">102</a> 
<a class="jxr_linenumber" name="103" href="#103">103</a> 	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a class="jxr_linenumber" name="104" href="#104">104</a> 
<a class="jxr_linenumber" name="105" href="#105">105</a> 	<strong class="jxr_keyword">private</strong> <a href="../../../../../com/googlecode/gwt/charts/client/RoleType.html">RoleType</a>(String name) {
<a class="jxr_linenumber" name="106" href="#106">106</a> 		<strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="107" href="#107">107</a> 	}
<a class="jxr_linenumber" name="108" href="#108">108</a> 
<a class="jxr_linenumber" name="109" href="#109">109</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">	 * Get the name of the RoleType.</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">	 * @return the name of the RoleType.</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> 	<strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="114" href="#114">114</a> 		<strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="115" href="#115">115</a> 	}
<a class="jxr_linenumber" name="116" href="#116">116</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

